<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.input.vo_format_writer.VOWriter</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.input-module.html">Package&nbsp;input</a> ::
        <a href="simvoc.input.vo_format_writer-module.html">Module&nbsp;vo_format_writer</a> ::
        Class&nbsp;VOWriter
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class VOWriter</h1><p class="nomargin-top"><span class="codelink"><a href="simvoc.input.vo_format_writer-pysrc.html#VOWriter">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_simvoc_i_13" name="uml_class_diagram_for_simvoc_i_13">
<area shape="rect" id="node172" href="simvoc.input.vo_format_writer.VOWriter-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="19,209,252,228"/>
<area shape="rect" id="node172" href="simvoc.input.vo_format_writer.VOWriter-class.html#write_vo" title="Writes a single VO record to the output list." alt="" coords="19,228,252,247"/>
<area shape="rect" id="node1" href="simvoc.input.vo_format_writer.VOWriter-class.html" title="Mechanism for writing VO list files in the format required by the core vo_format_reader module." alt="" coords="7,177,263,253"/>
<area shape="rect" id="node173" href="simvoc.input.common_writer.CommonWriter-class.html#write_time" title="Writes a clock timestamp to the output file, after which a record may be &#160;written." alt="" coords="17,39,255,57"/>
<area shape="rect" id="node173" href="simvoc.input.common_writer.CommonWriter-class.html#write_meta" title="Writes a single metadata record to the output file handle" alt="" coords="17,57,255,76"/>
<area shape="rect" id="node173" href="simvoc.input.common_writer.CommonWriter-class.html#write_meta_comment" title="Writes a metadata comment to the output file handle." alt="" coords="17,76,255,95"/>
<area shape="rect" id="node173" href="simvoc.input.common_writer.CommonWriter-class.html#write_line_comment" title="Writes a line comment to the output file handle." alt="" coords="17,95,255,113"/>
<area shape="rect" id="node173" href="simvoc.input.common_writer.CommonWriter-class.html#write_blank" title="Writes a blank line to the output file handle" alt="" coords="17,113,255,132"/>
<area shape="rect" id="node173" href="simvoc.input.common_writer.CommonWriter-class.html#check_time" title="Ensures that a call to write_time has been performed." alt="" coords="17,132,255,151"/>
<area shape="rect" id="node2" href="simvoc.input.common_writer.CommonWriter-class.html" title="simvoc.input.common_writer.CommonWriter" alt="" coords="5,6,267,157"/>
</map>
  <img src="uml_class_diagram_for_simvoc_i_13.gif" alt='' usemap="#uml_class_diagram_for_simvoc_i_13" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Mechanism for writing VO list files in the format required by the core
  vo_format_reader module. Writing a VO list is a two-step process: first, 
  the time at which a VO appears on the grid is written using write_time(),
  then the list of VOs is written using calls to write_vo(). It is 
  important to note that all calls to write_time() must be in 
  non-descending time order.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.vo_format_writer.VOWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">fh</span>,
        <span class="summary-sig-arg">normalize_time</span>=<span class="summary-sig-default">False</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.vo_format_writer-pysrc.html#VOWriter.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.vo_format_writer.VOWriter-class.html#write_vo" class="summary-sig-name">write_vo</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">vo</span>,
        <span class="summary-sig-arg">**kwds</span>)</span><br />
      Writes a single VO record to the output list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.vo_format_writer-pysrc.html#VOWriter.write_vo">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#check_time" class="summary-sig-name">check_time</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Ensures that a call to write_time has been performed.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.check_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="write_blank"></a><span class="summary-sig-name">write_blank</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Writes a blank line to the output file handle
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_blank">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_line_comment" class="summary-sig-name">write_line_comment</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">comment</span>)</span><br />
      Writes a line comment to the output file handle.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_line_comment">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_meta" class="summary-sig-name">write_meta</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Writes a single metadata record to the output file handle
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_meta">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_meta_comment" class="summary-sig-name">write_meta_comment</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">comment</span>)</span><br />
      Writes a metadata comment to the output file handle.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_meta_comment">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.input.common_writer.CommonWriter-class.html#write_time" class="summary-sig-name">write_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">timeval</span>,
        <span class="summary-sig-arg">is_offset</span>=<span class="summary-sig-default">False</span>)</span><br />
      Writes a clock timestamp to the output file, after which a record may
      be written.
      <em>(Inherited from <a href="simvoc.input.common_writer.CommonWriter-class.html">simvoc.input.common_writer.CommonWriter</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.input.common_writer-pysrc.html#CommonWriter.write_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">fh</span>,
        <span class="sig-arg">normalize_time</span>=<span class="sig-default">False</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.vo_format_writer-pysrc.html#VOWriter.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>fh</code></strong> - Open file handle (w mode) to which list will be written</li>
        <li><strong class="pname"><code>normalize_time</code></strong> (bool) - if True, times will be normalized relative to the first time 
          value written</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="write_vo"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">write_vo</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">vo</span>,
        <span class="sig-arg">**kwds</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.input.vo_format_writer-pysrc.html#VOWriter.write_vo">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Writes a single VO record to the output list. A call to write_time() 
  MUST proceed the first call to this method.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>vo</code></strong> (str) - Name of the Virtual Organization</li>
        <li><strong class="pname"><code>kwds</code></strong> - Extra VO data (names and values must NOT contain whitespace or 
          colons)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:35 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
